home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 049a / raee12.zip / RAAE.DOC < prev    next >
Text File  |  1991-02-26  |  16KB  |  370 lines
  1.  
  2.  
  3.  
  4.  
  5.          
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                            [*]    RAAE    [*]
  14.  
  15.                               Version  1.2
  16.  
  17.                  (C) Copyright 1990, 1991 By Randall Edwards
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                                DISCLAIMER 
  28.                                ----------
  29.  
  30.               The program RAAE.EXE and this documentation are the
  31.          copyrighted property of Randall Edwards. All rights, except 
  32.          those outlined in this document, are reserved. 
  33.  
  34.               By using this software you acknowledge that this 
  35.          software may not suit your particular needs or be completely 
  36.          trouble free.  Use this program at your own risk. 
  37.  
  38.               In no event will Randall Edwards be liable for any 
  39.          damages, including any lost profits, lost savings or other 
  40.          incidental or consequential damages arising out of the use of 
  41.          or inability to use these programs, even if Randall Edwards 
  42.          has been advised of the possibility of such damages. 
  43.  
  44.               In short, there's absolutely no guarantees with this 
  45.          program.  Use it at your own risk.  If you break it, you can 
  46.          have both pieces. 
  47.  
  48.  
  49.  
  50.  
  51.                           CREDIT WHERE CREDIT IS DUE 
  52.                           ---------------------------
  53.  
  54.               Thanks to Adam Hudson, who wrote the orignal QuickBBS 
  55.          program which led to RemoteAccess.  Thanks also to the 
  56.          RemoteAccess authors for their innovative work in BBS's. 
  57.  
  58.               Thanks to P.J. Muller who wrote a library for QuickBBS 
  59.          which I arrogantly hacked apart and modified in order to come 
  60.          up with routines to use in this program. 
  61.  
  62.               I give credit to the Taiwanese, who for near-slave wages 
  63.          produced this computer that this program was written on.  By 
  64.          allowing companies based in the United States to steal their 
  65.          labor and the profits from their hard work, I have the wealth 
  66.          and time to 'play' around with this machine and to write 
  67.          programs like this.  They have only their near-slave wages, 
  68.          terrible working conditions, and my appreciation and hope 
  69.          that they can overcome obstacles in their way and achieve 
  70.          full social justice. 
  71.          
  72.  
  73.  
  74.  
  75.                              PURPOSE AND USAGE 
  76.                              -----------------
  77.           
  78.               RAAE is a program to enter a message into RemoteAccess' 
  79.          message base.  RAAE will convert a text file into a message 
  80.          from the Sysop or from any other name and to whoever the
  81.          Sysop specifies or optionally to "All" users.
  82.  
  83.  
  84.  
  85.               RAAE stands for "RemoteAccess Auto-Enter."  It is 
  86.          pronounced like "ray" or "rae" as in "Norma Rae" that famous 
  87.          union working woman played by Sally Field in the movie of
  88.          the same name.  Smart, cute AND a determined union member?!
  89.          That's my kind of lady!  
  90.          
  91.               RAAE is dedicated to all the exploited workers of the 
  92.          world and to all workers struggling to form unions to get a 
  93.          fair share of the profits they themselves create. 
  94.          
  95.  
  96.               RAAE uses the following command line parameters:
  97.          
  98.          RAAE <BoardNumber> <FileSpec> [FirstName] [LastName]
  99.          
  100.               "BoardNumber" is a number 1-200 which tells RAAE to
  101.          put the message in a specific message area or "board" in 
  102.          RemoteAccess' message base.
  103.          
  104.               "FileSpec" is the name of a text file that will be 
  105.          converted into the message that RAAE generates.  This
  106.          parameter can contain an option drive/path specification.  
  107.          For instance, FILE.TXT and C:\TEMP\FILE.TXT are equally 
  108.          valid.  This text file should be plain ASCII text with no 
  109.          lines longer than 79 characters.  This text file may or
  110.          may not contain RAAE metacommands (see below).
  111.          
  112.               "FirstName" and "LastName" are two optional parameters.  
  113.          If one or both are given then the message is address to that 
  114.          person.  If neither the "FirstName" or "LastName" parameters 
  115.          are given, then the message will default as To: All.
  116.  
  117.               All messages generated by RAAE are listed by default     
  118.          as By: or From: <Sysop Name> where the "Sysop Name" is the 
  119.          name listed in RemoteAccess' CONFIG.RA file.  The Sysop's 
  120.          name is specified in the RACONFIG program.  In my case this 
  121.          would read: 
  122.  
  123.          By: Randy Edwards 
  124.  
  125.               You can change the default By: name by using a text file 
  126.          metacommand (explained below). 
  127.          
  128.               All messages have the default subject set to "Auto-Enter 
  129.          Message From <Sysop Name>".  Where Sysop Name is the name 
  130.          specified in RACONFIG's CONFIG.RA file.  Again, in my case 
  131.          this would look like: 
  132.  
  133.          Subj: Auto-Enter Message From Randy Edwards 
  134.  
  135.               You can change the default subject line by using a text 
  136.          file metacommand (explained below). 
  137.          
  138.  
  139.               To run the program just specify the proper parameters.  
  140.          For example:
  141.  
  142.  
  143.          
  144.          RAAE 1 C:\RA\TEST.MSG John Doe
  145.          
  146.          would create a message in board number 1 with the text from 
  147.          C:\RA\TEST.MSG and address it to John Doe. 
  148.  
  149.          RAAE 50 ECHO.RUL
  150.          
  151.          would create a message in board number 50 with the text from 
  152.          the file ECHO.RUL in the default directory, and address it to 
  153.          All. 
  154.  
  155.               RAAE will add a tear line to all messages it generates.  
  156.          If the board that it is posting a message into is an echomail 
  157.          board, as defined in the MESSAGES.RA file, then RAAE will 
  158.          also add the correct * Origin: line and node address that is 
  159.          specified for use with that message board. 
  160.  
  161.               There are many ways to use RAAE.  For instance, I 
  162.          moderate the ANEWS echo, an echo of alternative news, and I 
  163.          post the rules to ANEWS in the echo once a month on the first 
  164.          day of the month.  I use RAAE like this: 
  165.          
  166.           ErrorLvl DOM        <-- This determines the day of the month
  167.           IF ErrorLevel 2 GOTO START       <-- restarts the batch file
  168.           RAAE 10 C:\MISC\ANEWS.RUL        <-- run RAAE
  169.           IF ErrorLevel 1 MsgPack -I       <-- check for a RAAE error
  170.          
  171.               This sequence would create a message in ANEWS with the 
  172.          rules to the echo on the 1st of every month.  The message 
  173.          would be to "All" containing the text from C:\MISC\ANEWS.RUL.
  174.          
  175.               Another ingenious use of RAAE is to greet new users to 
  176.          your system.  For instance, the top lines of the file 
  177.          NEWUSER2.ASC of my system contains the following 2 lines:
  178.          
  179.           Please Wait ... 
  180.           ^XC:\UTILS\RAAE.EXE 1 C:\MISC\NEWUSER.MSG *F *L|
  181.          
  182.               This sequence runs a shell from a text file (the 
  183.          Control-X, ^X) which runs RAAE to generate a welcome
  184.          message in board 1 (my local message area).  RemoteAccess 
  185.          supplies the user's first and last names with the *F and *L 
  186.          macros.  Then during RemoteAccess' sign-on mail check the 
  187.          user will be told that s/he already has a message waiting
  188.          (even though it's her/his first call!).  This has surprised
  189.          quite a few users on my system.  See your RemoteAccess manual
  190.          for more information about doing shells from text files.
  191.          
  192.               I'm sure you'll be able to think up many more uses for 
  193.          RAAE.
  194.  
  195.  
  196.                             TEXT FILE METACOMMANDS
  197.                             ----------------------
  198.  
  199.               RAAE uses either a normal plan ASCII test file or a text 
  200.          file which contains RAAE metacommands.  The RAAE metacommands 
  201.          are commands which you can put inside of a text file to make 
  202.  
  203.  
  204.          the program produce different types of messages.  
  205.  
  206.               Metacommands take the format of "$x" where x is a 
  207.          particular letter of a metacommand.  The dollar sign ($) of a 
  208.          metacommand MUST be in column 1 of the text file, on the 
  209.          left-most side of the text file. 
  210.  
  211.             Some metacommands require a parameter besides the 
  212.          metacommand.  For those metacommands a space should separate 
  213.          the metacommand from the parameter.  Metacommands can be in 
  214.          upper or lower case.  Metacommands are not displayed in the
  215.          text of a message.
  216.          
  217.               The following are the metacommands that RAAE 
  218.          understands:
  219.          
  220.          $S <String> 
  221.               Use a different subject, where <String> is the subject 
  222.          line to use.  Only the first 72 characters of the subject 
  223.          line (after the 2 metacommand characters and one space) will 
  224.          be used. 
  225.  
  226.          $A <Address> 
  227.               Send a netmail message to <Address>.  The address must 
  228.          be a FULL four dimensional address of the format: 
  229.          Zone:Net/Node.Point.  You must include all four addresses.  
  230.          RAAE cannot send to a point, due to restrictions of the 
  231.          RemoteAccess/QuickBBS message database, but you must include 
  232.          a point number in your address.  RAAE always defaults the 
  233.          address to point 0.  If for any reason RAAE cannot decipher 
  234.          the address of the message, it will default to addressing the 
  235.          message to your own node so it won't cost you any money to 
  236.          send a mistaken message. 
  237.          
  238.          $F
  239.               This is a file-attach message.  The subject line of the 
  240.          message points to a file that is attached to the message. 
  241.          
  242.          $R
  243.               This is a return-receipt message.  An appropriate mailer 
  244.          will send back a receipt telling you that their system 
  245.          received the message.
  246.          
  247.          $C
  248.               Mark this message as a crash-mail message. 
  249.          
  250.          $K   
  251.               Mark this message as "kill/sent" so that a netmail-
  252.          export program will delete the message after it is exported.
  253.          
  254.          $P
  255.               Mark this message as private or privileged so that only 
  256.          the sender and receiver (and Sysop) can read the message.
  257.          Note: RAAE will not pay attention to RA's flag of whether a
  258.          particular message base is private only or not.  Use $P.
  259.  
  260.          $B <name string>
  261.               Make this message by or from <name string>.  This will
  262.          enable you to send messages by other people besides the
  263.          Sysop.  If the name string parameter is longer than 35
  264.          characters then it is shortened to 35 characters.
  265.          
  266.               Of course only the $P (Private), $S (Subject line) and 
  267.          $B (By/From) metacommands will effect an echomail or local 
  268.          message board type of message.  All of the other metacommands 
  269.          are reserved for matrix netmail messages.  If you try to 
  270.          specify one of the netmail metacommands for an echomail or
  271.          local message board it won't have any effect.
  272.  
  273.  
  274.  
  275.               Enclosed in the RAAE archive are a few of example text
  276.          files to show you how to use metacommands named MSG?XMPL.TXT.
  277.          
  278.  
  279.  
  280.          NOTES AND WARNINGS 
  281.          ------------------
  282.          
  283.               RAAE was coded for use on a single-line RemoteAccess 
  284.          system.  It contains no code for file-sharing or record-
  285.          locking and because of this reason it requires sole access
  286.          to RemoteAccess' message base files.
  287.            
  288.               RAAE has been tested extensively, but of course no 
  289.          guarantees are given.  If the program encounters an error it 
  290.          will return an errorlevel of 1.  If the program runs 
  291.          successfully it returns an errorlevel of 0. 
  292.  
  293.               I've never had the program corrupt a message base in 
  294.          testing.  The most common errors are that the text input file 
  295.          cannot be found, the board number is out of range (not 1 to 
  296.          200) and minor things like that.
  297.          
  298.               Because of the potential of a severe error corrupting 
  299.          RemoteAccess' message base, the program, if run from a batch 
  300.          file, should be trapped to determine the errorlevel it ends
  301.          with.  If the program ends with an errorlevel of 1 (an error
  302.          occured) then you should run a message base packing program
  303.          to re-create the index files to your message base.  While
  304.          this is normally not necessary, it is cheap insurance!
  305.          
  306.               For instance, in my batch file I run RAAE like this:
  307.          
  308.           RAAE 10 C:\MISC\ANEWS.RUL
  309.           IF ErrorLevel 1 HudBase Index
  310.          
  311.          or using QuickBBS' message pack program it'd look like:
  312.          
  313.           RAAE 10 C:\MISC\ANEWS.RUL
  314.           IF ErrorLevel 1 MsgPack -I
  315.          
  316.          This batch file chunk would detect an error and then run the 
  317.          appropriate program to create new index files.
  318.  
  319.               RAAE can be run from any directory.  It checks the
  320.          default directory and the RemoteAccess environment variable 
  321.          RA= to find the CONFIG.RA and MESSAGES.RA files.  Once it 
  322.          finds CONFIG.RA it then reads info such as the directory to 
  323.          where the message base is located, the Sysop's name, node 
  324.          numbers, and things like that.  From MESSAGES.RA it reads the 
  325.          type of board that it is to work on -- Local, Netmail or 
  326.          Echomail -- and which node number and origin line to use. 
  327.          Failure to find any of these files -- the message base files, 
  328.          CONFIG.RA and MESSAGES.RA -- will cause an error.
  329.  
  330.  
  331.  
  332.           VERSION HISTORY 
  333.           ---------------
  334.  
  335.          1.2  - Simple upgrade to run with RA version 1.00's files.
  336.  
  337.          1.11 - Added the $B (By/From) metacommand and did some 
  338.               cleanup of the code.  A couple of cosmetic changes too. 
  339.  
  340.          1.10 - The major changes in this release are the addition of 
  341.               the metacommands in the text file that is read.  This 
  342.               allows you to customize messages you send and it turns 
  343.               RAAE into a simple mail-robot type of program.
  344.  
  345.          1.0 - Initial public release. 
  346.  
  347.  
  348.  
  349.                                 LICENSE 
  350.                                 -------
  351.          
  352.               It's free.  If you like it use it.  If you don't like it 
  353.          then erase it from your disk(s) and forget all about it.  
  354.          
  355.               The only persons and/or organizations that are 
  356.          specifically forbidden to use this program are anyone 
  357.          employed by the Department of Defense and/or the National 
  358.          Security Agency of the United States Government. 
  359.          
  360.               Please don't modify and then redistribute the program 
  361.          and/or documentation.  
  362.          
  363.               Suggestions and bug reports may be sent to Randy Edwards 
  364.          at the Socialism OnLine! BBS at 1-203-274-4639, 300-14400 bps
  365.          HST, FidoNet 1:141/552.0 or Good Egg Net 99:9300/552.0. 
  366.  
  367.               Trademarks mentioned in this document are probably 
  368.          registered to their respective owners. 
  369.  
  370.